/**
 * Copyright (c) 2013-2022 Nikita Koksharov
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.redisson.client.protocol;

import java.io.IOException;

import org.redisson.client.handler.State;

import io.netty.buffer.ByteBuf;

/**
 * Decoder接口定义了解码操作，将某种输入转换为指定的输出结果。
 * @param <R> 解码后的结果类型。
 */
public interface Decoder<R> {

    /**
     * 解码给定的ByteBuf数据。
     * 此方法旨在从ByteBuf中解码出特定类型的对象。它需要当前的状态信息来辅助解码过程，
     * 例如，状态可以用于指示解码器处于解码过程的哪个阶段，或者用于管理解码过程中的一些上下文信息。
     *
     * @param buf 要解码的ByteBuf数据。
     * @param state 当前的解码状态，提供必要的上下文信息。
     * @return 解码后的对象，其类型由具体的解码器实现决定。
     * @throws IOException 如果解码过程中发生I/O错误。
     */
    R decode(ByteBuf buf, State state) throws IOException;

}
